Layout instance struct work - #1913

Do we actually know what these are? If not, I don't really like to see them being added.

Also, have a look at https://github.com/NotAdam/Lumina/blob/master/src/Lumina/Data/Parsing/Layer/LayerCommon.cs
This is quite old, but it could still match with what is copied in the SetProperties functions. :)
(Not for these ColliderLayers, just as a general note)

Do we actually know what these are? If not, I don't really like to see them being added.

Try these on for size:

0x56  ColliderLayer7   -> WaterRange            -> WaterRangeLayoutInstance
0x57  ColliderLayer8   -> ShowHideRange         -> ShowHideRangeLayoutInstance
0x58  ColliderLayer9   -> GameContentsRange     -> GameContentsRangeLayoutInstance
0x59  ColliderLayer10  -> EventEffectRange      -> EventEffectRangeLayoutInstance

Let's go ahead and use those names - those are taken from the layer groups they're in (I assume) so I'm happy with that. The only one I'm not suuper sure about and can't confirm is ColliderLayer9/GameContentsRange, do you know where that's used?

I'm not aware of 0x58/GameContentsRange being used anywhere, to be honest. And I suspect it's not actually "hooked up" to much of anything (yet? anymore?).

If anyone wants to bother doing a little digging/confirming:
WaterRangeLayoutInstance had 1 byte, first bit is 'Swimming' state, second is 'Underwater' state.

ShowHideRangeLayoutInstance had something like:

/* 0x80 */ uint count;
/* 0x88 */ LayerSetRef *refs;
/* 0x90 */ bool active:

Where LayerSetRef is just an array of uints (each one of those being a layerset id), and count is how many 'refs' there are.

I -believe- (!) that GameContentsRangeLayoutInstance has the same fields/semantics. So does EventEffectRangeLayoutInstance.

But EventEffectRangeLayoutInstance then also has something like:

/* 0x0094 */ float effectPointSpacing;
/* 0x0098 */ float effectFarClipBegin;
/* 0x009C */ float effectFarClipEnd;
/* 0x00A0 */ Vector3 effectBoundsCenter;
/* 0x00AC */ float effectBoundsRadius;
/* 0x00B0 */ bool effectsEnabled;
/* 0x00B4 */ uint effectPointCount;
/* 0x00B8 */ Vector3* effectPositions; // number of elements is effectPointCount, pretty sure this uses the 16-byte Vector3 variant
/* 0x00C0 */ Quaternion *effectRotations; // I don't remember what ffxivcs/SE calls it
/* 0x00C8 */ uint *effectIndices; // this is a mutable permutation of indices into effectPositions/effectRotations
/* 0x00D0 */ ActiveEffect activeEffects[185];
/* 0x1228 */ uint activeEffectsCount;
/* 0x1230 */ SpatialNode root;

And then the structs are likely close to:

struct ActiveEffect { // size 0x18
  /* 0x00 */ VfxObject *vfxObject; // think we already have it in Scene somewhere
  /* 0x08 */ SpatialNode *leaf;
  /* 0x10 */ uint effectIndex;
};

struct SpatialNode { // size 0x40
  /* 0x00 */ SpatialNode *childA;
  /* 0x08 */ SpatialNode *childB;
  /* 0x10 */ Vector3 boundsMin; // also the 16-byte variant used on these two
  /* 0x20 */ Vector3 boundsMax;
  /* 0x30 */ int effectIndexStart; // this is an offset into the effectIndices array in EventEffectRangeLayoutInstance
  /* 0x34 */ int availableEffectCount;
};

Essentially it's building a spatial search tree with a whole bunch of effect points, each one has AABB (boundsmin/max).

The effectIndexStart is what index in the effectIndices array this specific node's effects start at, availableEffectCount is how many elements are currently available.

So, if I understood this right (bold fucking claim), it works a little like this:

With: effectIndices = [3, 1, 0, 2, 6, 4, 5]

Player gets close enough to a leaf SpatialNode to spawn an Effect, say it has effectIndexStart of 2, and availableEffectCount of 2, so that'd cover the [0, 2] slice of the effectIndices array.
It selects 0 (first available effect), copies the next element over (2) to its spot, and decrements availableEffectCount.

So you get effectIndices = [3, 1, 2, 2, 6, 4, 5]

I realize this is a lot, so it's here just as a "if anyone wants to give a shit testing this out/confirming it experimentally, go for it"

Yeah that is extremely useful but I'll probably wait until my next layout PR (or after) :) I want to keep these small and reviewable. You're of course free to add on top though!

I'm not aware of 0x58/GameContentsRange being used anywhere, to be honest. And I suspect it's not actually "hooked up" to much of anything (yet? anymore?).

It is actually strange yeah, I would expect it to be used somewhere considering its location in the enum. But I wouldn't be surprised if we can't find it because its one of the stripped out ones ala BNpcs, Gatherings, QuestMarkers etc.

That's completely fair; just ping me or something if you ever end up PRing it, would be cool to see what's wrong/right